home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / time / TimeGuardian.lha / TimeGuardian_1,2a / doc / english / TGDoc.lha / TimeGuardian.asc next >
Text File  |  1995-01-18  |  93KB  |  2,402 lines
  1.  
  2.  
  3.                      Documentation of TimeGuardian
  4.                         Version 1.2, 11.1.1995
  5.        written by Markus Matern, Gerri Körner and Jürgen Matern
  6.  
  7.              translated by Gerri Körner and Markus Matern
  8.  
  9.                       Programpackage TimeGuardian
  10.                 (C)1993-95 G.Körner, M.Matern, J.Matern
  11.  
  12. This is the documentation of the package `TimeGuardian'
  13. Version 1.2, 11.1.1995.
  14.  
  15. The descriptions refers to the following programs:
  16.    * `TGCron' Version 1.50, 5.1.1995
  17.  
  18.    * `TimeGuardian' Version 1.50, 5.1.1995.
  19.  
  20.  
  21. Introduction
  22. *************
  23.  
  24. Welcome to the documentation of the program package
  25. `TimeGuardian'.
  26.  
  27. This package may be freely distributed, as long as no unreasonable copying
  28. and swapping fees are collected.  For any other type of distribution you
  29. must obtain the written permission of the author.  This package is
  30. shareware, if you want to use the programs of this package permanently, you
  31. have to register, see How Can I Register for `TimeGuardian'?  for further
  32. information.
  33.  
  34. This program package may be included in software collections, providing
  35. that the previously mentioned conditions are met.
  36.  
  37. This program package is provided without warranty of any kind. In no
  38. event will the author be liable for direct, indirect, or incidental
  39. damages resulting from any defect of the program or of its
  40. documentation. The users are hereby warned that such damage might occur.
  41.  
  42.  
  43. What is `TimeGuardian'?
  44. ========================
  45.  
  46. `TimeGuardian' is a program package which makes it easy for
  47. you to automate processes which have to be done over and over again. It
  48. reminds you about important events or allows you to start programs or
  49. scripts at predefined points of time. You also may write log files to
  50. disk, where you can see when your computer was switched on.
  51.  
  52.  
  53. The Features of `TimeGuardian'
  54. ===============================
  55.  
  56.    * easily configurable
  57.  
  58.    * providing a GUI for event input
  59.  
  60.    * reminder functions using requesters and alerts
  61.  
  62.    * daily actions
  63.  
  64.    * weekly actions
  65.  
  66.    * monthly actions
  67.  
  68.    * yearly actions
  69.  
  70.    * events after time intervals relating to the point of startup
  71.  
  72.    * detailed evaluation for the points of startup time
  73.  
  74.    * graphical representation for the points of startup time
  75.  
  76.    * precise information for special days
  77.  
  78.    * Localisation
  79.  
  80.    * Commodity
  81.  
  82.    * `Installer'
  83.  
  84.    * `MUI'-GUI
  85.  
  86.    * online help
  87.  
  88.    * `AREXX'
  89.  
  90.  
  91. What Can I Do with `TimeGuardian'?
  92. ===================================
  93.  
  94. The package provides you two main functions which may be used
  95. seperately from each other.
  96.  
  97. The first function provided is to save on disk every time your computer
  98. was turned on and off. You get a complete log file when anyone turned
  99. on your computer. Also you may choose to log different projects. This
  100. means that you can see in the log files when you worked on a certain
  101. project, e.g. private work and business work. You can analyse these log
  102. files easily with the graphical user interface, getting a quick
  103. overview while working with your computer on certain projects.
  104.  
  105. The second function that is provided by this package is a function to
  106. start actions (commands or scripts) that you want to be executed
  107. regularly or at specified dates or hours. Moreover you can start
  108. programs or scripts e.g. once a day or once a year .... A special
  109. function of this feature is the reminder. It reminds you by a requester
  110. or an alert, you simply enter the text and point of time for such
  111. events, the rest will be done for you by `TimeGuardian'.
  112.  
  113.  
  114. What Do I Need to Be Able to Use `TimeGuardian'?
  115. =================================================
  116.  
  117. If you want to use all features of the package `TimeGuardian',
  118. you need some other public domain or shareware packages which can't be
  119. included in this package because of different reasons:
  120.  
  121.    * OS version >= 2.0
  122.      You need a Workbench and Kickstart version greater or equal to 2.0
  123.      *by all means*. If you are not running those two versions, you
  124.      can't install this package. If you want to know which versions you
  125.      have installed, enter in a `Shell': `version'. You should get the
  126.      following results:
  127.      `Kickstart version 37.175, Workbench version 37.XX' or greater
  128.      numbers! You need a Workbench version >= 2.1 if you want to use the
  129.      localized graphical user interface!
  130.  
  131.    * `MUI' >= 2.0
  132.      The program package `MUI' has to be installed to be able to use
  133.      the graphical user interface of the program `TimeGuardian'.
  134.      You can use an unregistered version of `MUI' while you are testing
  135.      the program package. If you want to use `TimeGuardian'
  136.      regularly, please register for both packages `MUI' and
  137.      `TimeGuardian'. For further information on how to do this, see
  138.      How Can I Register for `TimeGuardian'? and Where May I Obtain `MUI'?.
  139.  
  140.    * `Installer'
  141.      You need this program for an easy installation of the package.  It
  142.      is included with many other program packages. To get information
  143.      where you can obtain the program `Installer', see Where Can I Obtain
  144.      `Installer'?
  145.  
  146.    * `Amiga-Guide'
  147.      You need this program in order to use a feature of the graphical
  148.      user interface of `TimeGuardian' called online help. If you
  149.      want to get information on how to obtain this package, see Where 
  150.      Can I Obtain `Amiga-Guide'?
  151.  
  152.  
  153. How Can I Register for `TimeGuardian'?
  154. =======================================
  155.  
  156. To be able to use the background program `TGCron' on a certain day
  157. as long as you want, you will need a certain file, which you will only
  158. get by registering. This file contains your name and is especially
  159. generated for you. If this file is missing, you will only be able to
  160. use the program about 3 hours a day.
  161.  
  162. To obtain your personal key file, please send the registration fee and
  163. form (see Registration Form) to one of the addresses below. If you
  164. send the money, be sure that one can't see the notes inside!  Put the
  165. notes inside the registration form.
  166. Please refer to the following table for the amount of your registration
  167. fee:
  168.  
  169.    * Inside Germany:
  170.         - Cash:               DM 20
  171.  
  172.         - Bank draft:         DM 20
  173.  
  174.         - National Cheque:    DM 20
  175.  
  176.         - Eurocheque:         DM 20
  177.  
  178.    * Inside Europe:
  179.         - Cash:               DM 20 oder US$ 15
  180.  
  181.         - Eurocheque:         DM 20 oder US$ 15
  182.  
  183.         - Cheque:             DM 40 oder US$ 27 (cashing is very
  184.           expensive!)
  185.  
  186.    * Outside Europe:
  187.         - Cash:               US$ 15
  188.  
  189.         - Cheque:             US$ 27 (cashing is very expensive!)
  190.  
  191. Here are the addresses of the authors:
  192.  
  193.                              Gerri Körner
  194.                              Kulturenweg 6
  195.                             D-87642 Buching
  196.  
  197.                              Markus Matern
  198.                          Max-Wieland-Straße 13
  199.                            D-89134 Blaustein
  200.  
  201. You will receive your personal key file and the newest version of the
  202. program package on disk. If you don't send your fee in a way mentioned
  203. above you won't become a registered user!
  204.  
  205. Your payment is for the current version of the program package
  206. `TimeGuardian'. You are neither entitled to get newer, nor to
  207. get enhanced program versions. You *don't* have to register again for
  208. possible new versions of this package. The personal key files will stay
  209. valid for new versions. Possible enhancements of the package will
  210. depend on the number of registrations.
  211.  
  212. You can't reach us by phone, therefore if you have questions, please
  213. send an *international reply coupon* to one of the adresses above.  The
  214. better way is to send an e-mail to:
  215.                  `Gerri.Koerner@student.uni-ulm.de' or
  216.                   `Markus.Matern@student.uni-ulm.de'.
  217. Unfortunately we will not be able to answer any questions asked in other
  218. ways.
  219.  
  220.  
  221. The Programs of the Package `TimeGuardian'
  222. *******************************************
  223.  
  224. The package `TimeGuardian' basically consists of two programs,
  225. which are needed both for proper work. They will be described later.
  226. You need the preferences program `TimeGuardian' if you want to
  227. change the configuration of the "cron" (1) which runs in the background
  228. or to analyze the files written to your disk. The second program is
  229. `TGCron'. You should start it every time your computer boots, if
  230. you want to use the package in a sensible way. `TGCron' uses two
  231. small modules for rarely needed functions. These modules won't be
  232. described here as they are not for public use. See How Do I Install
  233. `TimeGuardian'?, for further information.
  234.  
  235. For further information on programs not included in this package refer
  236. to Where Do I Get the Support Programs?.
  237.  
  238.    ---------- Footnotes ----------
  239.  
  240.    (1)  A cron is a program which executes programs or scripts at
  241. certain user-specified points of time
  242.  
  243.  
  244. The Program `TimeGuardian'
  245. ===========================
  246.  
  247. First of all I want to say something general about the documentation of
  248. `TimeGuardian':
  249.  
  250. A GUI should help to work easier with a program and use its features
  251. without detailed knowledge. Many people draw the conclusion that they
  252. dont't have to read its documentation. That's definitely wrong. I tried
  253. to arrange many parts of this program to be operated without any basic
  254. knowledge. Nevertheless I advise you to read this documentation once,
  255. after that you may use the online help function. It will display the
  256. corresponding text to any object of the GUI from the file
  257. `TimeGuardian.guide'. Because of its many features and the very
  258. powerful syntax of the "CronTable"(1) , it is impossible to develop a
  259. GUI which may be used without any basic knowledge.
  260.  
  261. The preferences program `TimeGuardian' was designed to help the
  262. user to modify the configuration of the background program easily. It
  263. provides you a graphical user interface to do so. If you want to change
  264. the configuration, just start `TimeGuardian'.
  265.  
  266.    * From Workbench: Doubleclick on the corresponding icon. If you
  267.      followed the installation instructions, you will find the icon in
  268.      your drawer `Prefs' of your bootpartition.
  269.  
  270.    * From CLI: Just enter `<path>/TimeGuardian'. Instead of
  271.      `<path>' you have to enter the name of the drawer in which you
  272.      have installed the package `TimeGuardian'.
  273.  
  274.    * If you entered in the icon of `TGCron' at the installation
  275.      drawer a `CX_POPKEY' tooltype (not in the WBStartup drawer), you
  276.      may use this short cut to pop up the GUI of `TimeGuardian'
  277.      while `TGCron' is running.
  278.  
  279. The following is a description of the different elements of the
  280. graphical user interface and their functions. "Gadgets" are elements
  281. that start an action immediately. They may be activated by clicking on
  282. them with the mouse or by pressing the underlined character of their
  283. name.  You have to press always a single key on the keyboard, even if a
  284. capital letter is underlined. "Pages" are gadgets which activate other
  285. gadgets. Depending on the preferences of `MUI', you may see all the
  286. page-gadgets together or each at a time by activating the visible
  287. page-gadget. For browsing through the pages you may also use the
  288. keyboard. The combination `ALT <arrow left>' or `ALT <arrow right>'
  289. allows you to step one page forward or back.
  290.  
  291.    ---------- Footnotes ----------
  292.  
  293.    (1)  A "CronTable" is an ASCII file which contains command lines for
  294. cron program.
  295.  
  296.  
  297. The Menus of the Program `TimeGuardian'
  298. ----------------------------------------
  299.  
  300. Some functions of the program may be activated using gadgets and menus.
  301. Moreover the basic preferences for the cron have to be done on two
  302. windows which may only be activated using the menu. For a further
  303. description see below. The functions that are available via gadget and
  304. menu will be described at the corresponding gadgets. The menu structure
  305. of the preferences program looks like follows:
  306.  
  307.    * Project     
  308.               
  309.  
  310.         - Open...     
  311.  
  312.         - Save as...
  313.  
  314.         - ----------------
  315.  
  316.         - About     
  317.  
  318.         - User
  319.  
  320.         - Iconify
  321.  
  322.         - ----------------
  323.  
  324.         - Quit     
  325.  
  326.    * Edit
  327.         - Reset to Defaults     
  328.  
  329.         - Last Saved     
  330.  
  331.         - Restore     
  332.  
  333.    * Settings     
  334.               
  335.  
  336.         - Create Icons?     
  337.  
  338.    * Pages     
  339.         - Timer
  340.  
  341.         - Special
  342.  
  343.         - Global Statistics
  344.  
  345.         - Daily Statistics     
  346.  
  347.    * Preferences     
  348.         - Cron Setup
  349.  
  350.         - Log Path & Names
  351.  
  352.         - -----------------
  353.  
  354.         - LogFiles enabled?
  355.  
  356.  
  357. The Menu `Project=>Open...'
  358. ............................
  359.  
  360. Selecting this menu item opens a file-requester which allows you to
  361. load a configuration file.  If you don't select a
  362. `TimeGuardian'- config-file, an error message will appear.  After the
  363. file has been loaded succesfully, all items of the graphical user
  364. interface will show the new configuration.  After that you may modify,
  365. save or use the new settings in the usual way.
  366.  
  367.  
  368. The Menu `Project=>Save as...'
  369. ...............................
  370.  
  371. By activating this menu, you may save your current settings under any
  372. name you choose. The configuration will just be saved, it will not be
  373. used by a current running cron. You have to select the gadget `Save' or
  374. `Use' if you want to do so. This menu is provided to be able to change
  375. quickly between often used configuratons (e.g. one configuration for
  376. private work and one for business work). Each configuration has its own
  377. name which allows you to associate it with the corresponding project.
  378. If the menu `Settings=>Create Icons?' is activated an icon will be
  379. generated for each configuration you save. If you want to use one of
  380. your saved configurations you have to doubleclick on the corresponding
  381. icon. This configuration is only used as long as you don't boot. If you
  382. want to use this configuration permanently by doubleclicking the icon,
  383. then change the `Tool Types' of the icon to `ACTION=SAVE'.
  384.  
  385. If you saved a configuration without an icon you have to activate this
  386. configuration as follows: Either load the configuration in the
  387. preferences program and press `Use' or enter the two following lines in
  388. a shell or a script: `copy Name.config env:TimeGuardian.config' and
  389. `setenv TimeGuardian.com config'. The configuration will stay active
  390. until you reboot. (For a permanent change press the `Save' gadget or
  391. you `copy Name.config envarc:TimeGuardian.config' and enter the two
  392. lines above.)
  393.  
  394.  
  395. The Menu `Project=>About'
  396. ..........................
  397.  
  398. Activating this menu item opens the information window which you have
  399. already seen during the startup of the program. The difference is that
  400. you have to close the window by hand now. You may do this by clicking
  401. on the 'OK' button at the bottom of the window. During startup, the
  402. window will dissapear automatically after moving the mouse or pressing
  403. any key.
  404.  
  405. The window shows the copyrights, the shareware reference and the
  406. reference to MUI.
  407.  
  408.  
  409. The Menu `Project=>User'
  410. .........................
  411.  
  412. If you activate this menu you will be shown an information window in
  413. which the following message is displayed
  414.  
  415.                   This TimeGuardian is registered to:
  416.  
  417.                          *Firstname Lastname*
  418.                                 Street
  419.                            Postcode Location
  420.                                 Country
  421.  
  422. if you are a registered user otherwise, if you haven't registered yet,
  423. the display will read
  424.  
  425.                   This is a *unregistered* version of
  426.  
  427.                              TimeGuardian
  428.  
  429.                       you have to register after
  430.                     an evaluation time of 14 days!!
  431.  
  432. If you want to know how to register for `TimeGuardian', see
  433. How Can I Register for `TimeGuardian'?.
  434.  
  435.  
  436. The Menu `Project=>Iconify'
  437. ............................
  438.  
  439. If you activate this menu, the program will close the window of the
  440. graphical user interface and appear as an icon on the Workbench. If you
  441. want to reactivate the window, you have to doubleclick the icon. You
  442. may also use the third gadget from the right on the upper window border.
  443.  
  444.  
  445. The Menu `Edit=>Reset to Defaults'
  446. ...................................
  447.  
  448. If you click on the gadget `Default', the default values will appear.
  449. These are the original default settings which were shown to you after
  450. your first startup after installation.
  451.  
  452.  
  453. The Menu `Edit=>Last Saved'
  454. ............................
  455.  
  456. If you activate this menu, the configuration file that you saved with
  457. the gadget `Save' will be loaded. When the file is loaded succesfully,
  458. you may edit, use or save it in the usual way.
  459.  
  460.  
  461. The Menu `Edit=>Restore'
  462. .........................
  463.  
  464. With the menu item`Restore' you may cancel changes you may have made
  465. before. It'll work as long as you did not use one of the two gadgets
  466. `Save' or `Use'.
  467.  
  468.  
  469. The Menu `Settings=>Create Icons?'
  470. ...................................
  471.  
  472.    If this menu item is checkmarked, each time you save a configuration
  473. with the menu
  474. `Project=>Save As', an icon for the configuration will be created.
  475.  
  476.  
  477. The Menu `Preferences=>Cron Setup'
  478. ...................................
  479.  
  480. This menu item allows you to open the window where you may enter the
  481. basic setup of the cron. You will see the following buttons and sliders.
  482.  
  483.  
  484. The Slider `Startuptime'
  485. .........................
  486.  
  487. You may use this slider to enter the time in minutes, your computer
  488. needs to boot, rounded to the next full minute. If your system needs for
  489. example two minutes and 30 seconds to start, you would have to enter
  490. three here. This is necessary, as the background program has to decide
  491. whether the computer was switched on or had a reset. The program
  492. decides, that the computer was switched on, if the difference between
  493. the last saved value and the actual time is greater than the value that
  494. you entered with the slider. Otherwise a reset is supposed.
  495.  
  496.  
  497. The Slider `Increment'
  498. .......................
  499.  
  500. This value is the time in minutes, when the background program saves,
  501. that the computer was still working. The smaller you make this value,
  502. the more accurate are the values in the three saved log-files. If you
  503. enter two, for example, every two minutes will be saved, that the
  504. computer was still working. The greatest error which may occur for this
  505. value will be two. The greater the entered value, the inaccurate is the
  506. supposed switch off moment, as the last saved value for a running
  507. system is taken.
  508.  
  509.  
  510. The Slider `Log History'
  511. .........................
  512.  
  513. Select how many month will be stored in the data files. At the
  514. beginning of every month an external module will be started which
  515. deletes all outdated entries from the data files. You may store the
  516. datas of 2 years (=24 month), this is the predefined maximum. But you
  517. may set this value to one year for example and make a copy of the
  518. datafiles at the beginning of every new year. You won't loose any data
  519. this way.
  520.  
  521.  
  522. The Gadget `Date Format'
  523. .........................
  524.  
  525. With this gadget you may enter nine different formats for the date, that
  526. will be used, when saving the time in the different files. The following
  527. formats may be selected:
  528.      `tt-mm-jj', `tt.mm.jj', `tt/mm/jj',
  529.  
  530.      `mm-tt-jj', `mm.tt.jj', `mm/tt/jj',
  531.  
  532.      `jj-mm-tt', `jj.mm.tt', `jj/mm/tt'.
  533.  
  534. `tt' represents the day of the month, `mm' the short form of the month
  535. and `jj' the last two digits of the year. The short form of the month
  536. will be saved in the selected language.
  537.  
  538.  
  539. The Gadget `Locale'
  540. ....................
  541.  
  542. Select a language for the background program `TGCron' with this
  543. gadget.  The configuration program will *always* appear localized in
  544. the language you have selected in the language preferences program (of
  545. course you need an approriate file `TimeGuardian.catalog'
  546. installed in your drawer `Locale:Catalogs/language').  If this file is
  547. missing or if you use a workbench version < 2.1 the program will run in
  548. the default language English.  This distribution contains only the
  549. default language English and a German catalog.
  550.  
  551. You may select six different settings:
  552.    * localized:
  553.      Use this if you have a localized workbench and you want the files
  554.      for the time functions to be written in this language. You need
  555.      the appropriate file for your language!
  556.  
  557.    * English:
  558.      By selecting this or one of the following items, the text will be
  559.      written in the selected language to the files.
  560.  
  561.    * German, French, Italian, Spanish:
  562.      time functions: selected language
  563.  
  564. If you are intrested in translating the text of the graphical user
  565. interface into one of the languages above or into your own, please get
  566. in contact with one of the addresses at which you can register for the
  567. package, see How Can I Register for `TimeGuardian'?. As a reward you
  568. will get a registered version of `TimeGuardian' for free.
  569. Please contact one of us *at all events*, before you start to translate!
  570.  
  571.  
  572. The Slider `Cron Task Priority'
  573. ................................
  574.  
  575. It is possible that the cron program won't work precise if the CPU
  576. usage is 100% (e.g. running a ray-tracing program). Therefore you may
  577. change the task priority of `TGCron' here. You should select a
  578. value higher than the priority of the program which uses the whole CPU
  579. power. The default value of 4 should work fine anyway.
  580.  
  581.  
  582. The Gadget `Use'
  583. .................
  584.  
  585. If you choose this button for closing the window your current changes
  586. will be used. If you entered something wrong and don't want to use the
  587. changes click on the `Cancel' button.
  588.  
  589.  
  590. The Gadget `Cancel'
  591. ....................
  592.  
  593. If you click on `Cancel' instead of `Use' your current changes will get
  594. lost and everything will be reset to the previous values.
  595.  
  596.  
  597. The Menu `Preferences=>Log Path & Names'
  598. .........................................
  599.  
  600. This menu item opens the window where you may enter the path and the
  601. names of the log files.
  602.  
  603. The String Gadget `Log Path'
  604. ............................
  605.  
  606. In this string gadget you have to enter the drawer or partition, where
  607. the cron program is supposed to save when the computer has booted and
  608. how long and at what time it was switched on. You can enter the names
  609. of these three files in the following string gadgets.
  610.  
  611. If you want to change the path, activate the string gadget and enter the
  612. desired path.  If the path does not exist, a requester will popup which
  613. allows you to create it.  When you activate the string gadget with the
  614. gadget to the right of it, a file requester pops up, where you can
  615. easily select the path.
  616.  
  617. The String Gadget `Runtime'
  618. ...........................
  619.  
  620. Enter the file in which `TGCron' is supposed to save, how long the
  621. computer was switched on and at which dates. If the file doesn't already
  622. exist, it will be created in the drawer or partition you selected at
  623. the gadget `Log Path'.
  624.  
  625. The entry for a day will be written on the following day, when you
  626. switch your computer on. That implies, if you look at this file the
  627. actual day will not be shown.
  628.  
  629. The file is saved in ASCII format and may be loaded with any editor or
  630. text viewer. A sample file could look like this:
  631.      Wed   04-May-94 Runtime:  2 h  47 min.
  632.      Thu   05-May-94 Runtime:  2 h  43 min.
  633.      Mon   09-May-94 Runtime:  3 h  11 min.
  634.  
  635. The date format may be changed, see The Gadget `Date Format' for
  636. further information.
  637.  
  638. The String Gadget `Starts'
  639. ..........................
  640.  
  641. Here you have to enter the name of the file in which `TGCron' is
  642. supposed to save the time when the computer has been reset. The file
  643. will be created in the drawer described above if it doesn't exist
  644. already.
  645.  
  646. The values in the file will only show your real boot times if you start
  647. the program `TGCron' every time your computer is booting. See How Do 
  648. I Install `TimeGuardian'? how to do this.
  649.  
  650. If you start `TGCron' manually, you may, each time you work on a
  651. certain project, start the program. Thus you have a protocol for this
  652. specific project. You can do this in a another way, too. Start the
  653. program `TGCron' everytime and change the configuration for
  654. different projects. Afterward define a configuration for a certain
  655. project and save it using the menu `Project=>Save As'. When you start
  656. working on the project you use the menu `Project=>Open' to load it. For
  657. further information, see The Menu `Project=>Open...' and The 
  658. Menu `Project=>Save as...'.
  659.  
  660. The file is saved in ASCII format and may be loaded with any editor or
  661. text viewer. A sample file could look like this:
  662.      Wed   04-May-94 15:26
  663.      Thu   05-May-94  8:24
  664.      Thu   05-May-94 14:26
  665.      Thu   05-May-94 15:22
  666.      Thu   05-May-94 16:01
  667.  
  668. The date format may be changed, see The Gadget `Date Format' for
  669. further information.
  670.  
  671. The String Gadget `OnOff'
  672. .........................
  673.  
  674. Enter the file in which `TGCron' is supposed to save the times the
  675. computer was switched on and off. If the file doesn't already exist, it
  676. will be created in the drawer or partition mentioned above.
  677.  
  678. The entry for the current "switch on" will be appended to the file the
  679. next time the computer will be switched on. Such a file could look like
  680. the following:
  681.      System switched on:   Wed   04-May-94 17:38
  682.      Resets:  0
  683.      System switched off:  Wed   04-May-94 19:26
  684.      
  685.      System switched on:   Thu   05-May-94  8:24
  686.      Resets:  0
  687.      System switched off:  Thu   05-May-94  9:25
  688.      
  689.      System switched on:   Thu   05-May-94 14:26
  690.      Resets:  2
  691.      System switched off:  Thu   05-May-94 16:11
  692.  
  693. The date format may be changed, see The Gadget `Date Format' for
  694. further information.
  695.  
  696. The decision whether the computer was switched on or had a reset will
  697. be made depending on the settings of the slider `Startuptime', see The
  698. Slider `Startuptime', for further information.
  699.  
  700. The Gadget `Use'
  701. ................
  702.  
  703. If you choose this button for closing the window your current changes
  704. will be used. If you entered something wrong and don't want to use the
  705. changes click on the `Cancel' button.
  706.  
  707. The Gadget `Cancel'
  708. ...................
  709.  
  710. If you click on `Cancel' instead of `Use' your current changes will get
  711. lost and everything will be reset to the previous values.
  712.  
  713.  
  714. The Menu `Preferences=>LogFiles enabled?'
  715. ..........................................
  716.  
  717. If this menu item is checkmarked, the cron program will create a logfile
  718. how long and at which point of time your computer was running. You have
  719. to choose a directory in the `Log Path & Names' window, even if you don
  720. not use the LogFile feature, as some of the special Cron abilities need
  721. information from the `TG_private' subdirectory. Data are only written
  722. at the first startup of a day to this drawer, after that `TGCron'
  723. will behave like a pure Cron/Reminder.
  724.  
  725.  
  726. The Page `Timer'
  727. -----------------
  728.  
  729. This page is shown if you carry out one of the following actions on the
  730. graphical user interface:
  731.    * Press the gadget `Timer'
  732.  
  733.    * Select the menu `Pages=>Timer'
  734.  
  735.    * Press the keys `Amiga 1'
  736.  
  737.    * Press the keys `Alt <arrow right>', while you are on the page
  738.      `Daily Statistics'
  739.  
  740.    * Press the keys `Alt <arrow left>', while you are on the page
  741.      `Special'
  742.  
  743. You may select all time dependand functions of `TGCron' on this
  744. page. You will see two main groups: The "CronTable" function and the
  745. interval timer.
  746.  
  747. If you started `TimeGuardian' for the first time the all string
  748. gadgets will be ghostet. You have to choose the type of your timer
  749. function with the cycle button at the top of the page.
  750.  
  751.  
  752. The Gadget `Type'
  753. ..................
  754.  
  755. By using this gadget you may select which type of background actions
  756. will take place:
  757.    * None:
  758.      Neither the command/ script in the string gadget `Interval', nor
  759.      the "CronTables" will be executed.
  760.  
  761.    * Cron Table:
  762.      Only the two "CronTables" will be executed. If you want ot enter
  763.      such a file use a text editor or the very comfortable `scheduler',
  764.      you may get into it by clicking on one of the `Edit' buttons.
  765.  
  766.    * Interval:
  767.      Only the command/ script in the string gadget `Interval' will be
  768.      executed in the selected interval as long as the computer is
  769.      working.
  770.  
  771.    * Cron Table & Interval:
  772.      Both, commands/ scripts and "CronTables" will be executed. t
  773.  
  774.  
  775. The String Gadget `Default/ Current'
  776. .....................................
  777.  
  778. You may select a "CronTable"(1) file here where you may store which
  779. programs have to be started at certain times.
  780.  
  781. There are two different "CronTables" provided on this page which may be
  782. used separately from each other. Thus it is easier for you to generate
  783. one "CronTable" for actions which will happen regardless of the current
  784. configurations, the other will depend on it. The difference between
  785. both them is the fact that the `Default' "CronTable" won't be reread
  786. when you change the configuration of running cron. This may happen if
  787. you switch to another project you are working on. The `Standard'
  788. "CronTable" will always be reread whenever you change your
  789. configuration. A notification is set on both files, therefore the
  790. "CronTable" will be reread if you save something the file in any way.
  791.  
  792. This file has to be an ASCII file with a certain format that will be
  793. described at The "CronTable"-Syntax. It is possible to use samples in this
  794. file or certain days, months, etc.
  795.  
  796. If you click on the gadget right beside the string gadget, a file
  797. requester will pop up with which you may easily select the desired
  798. file. You may access these string gadgets only if you have selected
  799. `CronTable' or `CronTable & Interval' at the `Type' cycle button.
  800. Otherwise the string gadgets will be ghosted.
  801.  
  802. If you click on one of the `Edit' buttons right beside the
  803. string-gadgets you will get into the program `TGScheduler', refer to
  804. The Program `TGScheduler'. This program will help you with its graphical
  805. user interface to create the very cryptic "CronTable" files.
  806.  
  807.    ---------- Footnotes ----------
  808.  
  809.    (1)  The format is the same as used in Un*x,has been enhanced by
  810. some very useful features.
  811.  
  812.  
  813. The String Gadget `Interval'
  814. .............................
  815.  
  816. You may select a file here that will be executed in regular time
  817. intervals. Therefore this entry may be used to save the project you are
  818. currently working on every ten minutes. The point of time this will
  819. happen are always relative to the boot time, i.e. (boot time + n *
  820. interval). To change the interval see The Sliders `Hours'/ `Minutes'.
  821.  
  822. If you press the gadget to the right of the string gadget, a file
  823. requester will pop up with which you may select the desired file.  You
  824. may change the entry in this string gadget only if `Interval' or
  825. `CronTable & Interval' has been selected at the `Type' gadget,
  826. otherwise the gadget will be ghosted.  You may select an executable or a
  827. script in ASCII format.  If you want to use a script the `S- flag' has
  828. to be set.  To set this flag for the script `Example' in the directory
  829. `s:', type in a `CLI' window:  `protect s:Example s add'. You have to
  830. start commands in a script with their full path!  You don't need the
  831. path if you use internal commands or commands in the `C:'-directory.
  832.  
  833.  
  834. The Sliders `Hours'/ `Minutes'
  835. ...............................
  836.  
  837. Set the interval time, at which the command/ script `Interval' will be
  838. executed regularly.  You have to set the minutes and hours seperately.
  839. If you set the slider `Hours' to 0 and the slider `Minutes' to 15, the
  840. command/ script will be executed every fifteen minutes.  You may change
  841. these two values only if you selected `Cron Table & Interval' or
  842. `Interval' at the gadget `Type', otherwise the two sliders will be
  843. ghosted (see The Gadget `Type').
  844.  
  845.  
  846. The Page `Special'
  847. -------------------
  848.  
  849. You may select some files here that will be executed at the given
  850. points of time.  The same functions may be achieved using a "CronTable"
  851. entry, but this page is provided for the following two reasons:  First
  852. the compatability to the old versions and second to enable you to test
  853. and use some functions in a fast and simple way.
  854.  
  855. This page is shown if you carry out one of the following actions on the
  856. graphical user interface:
  857.    * Press the gadget `Special'
  858.  
  859.    * Select the menu `Pages=>Special'
  860.  
  861.    * Press the keys `Amiga 2'
  862.  
  863.    * Press the keys `Alt <arrow right>', while you are on the page
  864.      `Timer'
  865.  
  866.    * Press the keys `Alt <arrow left>', while you are on the page
  867.      `Global Statistics'
  868.  
  869. When you start `TimeGuardian' for the first time, you will find the
  870. string gadgets empty. Otherwise you will see the last saved
  871. configuration.
  872.  
  873.  
  874. The String Gadget `Once a day'
  875. ...............................
  876.  
  877. You may select a file here that will be executed once a day.  The file
  878. will be executed only once a day regardless of the time the computer is
  879. switched on.  If the computer is powered on at midnight, it will be
  880. executed right past midnight.  This entry is not usable for polling at
  881. your mailbox once a day because the point of time when this will happen
  882. is not fixed.  It is intended for commands which you don't want to
  883. execute from your `Startup-Sequence' each time your computer boots. 
  884. Once a day you can make a backup of important files or update your
  885. database for a fast file search.
  886.  
  887. If you press the gadget right of the string gadget, a file requester
  888. will pop up in which you may easily select the desired file.  You may
  889. choose an executable or a script in ASCII format.  If you want a script
  890. to be executed, the `S-flag' has to be set, for example, the script
  891. `Once_a_day' in the drawer `S:'.  Enter `protect S:Once_a_day s add' in
  892. a CLI to set this flag.  You have to start commands in a script with
  893. their full path!  You won't need the path if you use internal commands
  894. or commands in the `C:'-directory.
  895.  
  896. A sample script may look like this:
  897.      ;Script once a day
  898.      dir all sys: > T:.directorytree ;for fast file search
  899.      copy T:.directorytree sys:
  900.      delete T:.directorytree
  901.  
  902. The commands will be automatically started as a background task.  You
  903. won't have to enter anything like `run < nil:  > nil:  Command'.  Before
  904. adding a command line to a script you should execute it in a `Shell',so
  905. you can be sure that it works in the intended way.  In case you get
  906. problems running the command from the script, you may redirect the
  907. output to a file:  `Command > Sys:.logfile'.  Read the file
  908. `Sys:.logfile' with a text viewer or an editor to check what went wrong
  909. (you may check this file with `type Sys:.logfile' in a `Shell', too).
  910.  
  911.  
  912. The String Gadget `Once a week'
  913. ................................
  914.  
  915. You may select a file here that will be executed once a week.  The file
  916. will be executed only once a week regardless of the day of the week the
  917. computer is switched on.
  918.  
  919.  
  920. The String Gadget `Once a month'
  921. .................................
  922.  
  923. You may select a file here that will be executed once a month.  The file
  924. will be executed only once a month regardless of the day the computer is
  925. switched on.
  926.  
  927.  
  928. The String Gadget `Once a year'
  929. ................................
  930.  
  931. You may select a file here that will be executed once a year.  The file
  932. will be executed only once a year, regardless of the point of time at
  933. which the computer was switched on for the first time in a certain
  934. year.  If the computer is running at the turn of the year, it will be
  935. executed right post midnight.  You could use this entry to copy the
  936. files that the cron program produced to a different directory.
  937.  
  938.  
  939. The Page `Global Statistics'
  940. -----------------------------
  941.  
  942. This page is shown if you carry out one of the following actions on the
  943. graphical user interface:
  944.    * Press the gadget `Global Satistics'
  945.  
  946.    * Select the menu `Pages=>Global Statistics'
  947.  
  948.    * Press the keys `Amiga 3'
  949.  
  950.    * Press the keys `Alt arrow right', while you are on the page
  951.      `Special'
  952.  
  953.    * Press the keys `Alt arrow left', while you are on the page `Daily
  954.      Statistics'
  955.  
  956. A table will be displayed on this page where you may see at which days
  957. of the current logfile the computer was working and how long.  While
  958. controlling different projects with different configurations the times
  959. and dates shown correspond to the selected configuration.  You may move
  960. around in the upper field of the page like follows:
  961.    * Press the Tab key and use the keys Cursor up or Cursor down: Each
  962.      time you press one of the keys the bar moves up or down a day.
  963.  
  964.    * Click on the desired day with your mouse.
  965.  
  966.    * Move the proportional gadget to the right side of the Listview and
  967.      then click on the desired day with your mouse.
  968.  
  969.    * Click on the gadgets next to the proportional gadget and then
  970.      choose the desired day.
  971.  
  972. If the desired day has been highligted as mentioned above you should
  973. activate the page `Daily Statistics' in one of these ways:
  974.  
  975.    * Press the Return key (the highlighted day will be shown)
  976.  
  977.    * Doubleclick on the desired day (this will also work if no day has
  978.      been selected yet)
  979.  
  980. At the bottom you will see two buttons.  By clicking on them you may
  981. pop up as information window:
  982.  
  983.    * Statistics:
  984.      A window will be opened which displays detailed information on the
  985.      global runtime, maximum and minimum, furthermore on the
  986.      startups/resets and onoff-cycles.
  987.      The text lines are written on alternating background colors. To
  988.      get this effect which makes it easier to read the table choose
  989.      different colors or greyscales for the pens `Halfshine' and
  990.      `Halfshadow' in the preferences program of `MUI'.
  991.  
  992.    * Graphics:
  993.      A graphics window will be opened. This window has not been
  994.      finished yet in the current release. To be able to realize all
  995.      planned functions the next versions will need `MUI 2.2'!
  996.  
  997.  
  998. The Page `Daily Statistics'
  999. ----------------------------
  1000.  
  1001. This page is shown if you carry out one of the following actions on the
  1002. graphical user interface:
  1003.    * The gadget `Daily Satistics'
  1004.  
  1005.    * Select the menu `Pages=>Daily Statistics'
  1006.  
  1007.    * Press the keys `Amiga 4'
  1008.  
  1009.    * Press the keys `Alt arrow right', while you are on the page
  1010.      `Global Statistics'
  1011.  
  1012.    * Press the keys `Alt arrow left', while you are on the page `Timer'
  1013.  
  1014. This page contains three main areas.  In the uppermost you may select
  1015. which information will be shown in the middle of the page:
  1016.    - OnOff:
  1017.      This will show when the computer was switched on, how many resets
  1018.      it had, and at what time it was switched off.
  1019.  
  1020.    - Starts:
  1021.      The times when your computer had a reset or was turned on will be
  1022.      displayed here.
  1023.  
  1024. In the downmost area you'll see a summary of the selected day.  If you
  1025. cannot see all entries together, you may move the proportional gadget
  1026. the same way as on the page `Global Statistics'.  If you want to switch
  1027. between the two views `OnOff' and `Starts', you may press the Space
  1028. bar.  Furthermore you may use the keys Alt arrow up/down to browse
  1029. through the days.  The active day will be changed on the page `Global
  1030. Statistics', too.
  1031.  
  1032.  
  1033. The Gadgets `Save'/ `Use'/ `Quit'
  1034. ----------------------------------
  1035.  
  1036. The Gadget `Save'
  1037. .................
  1038.  
  1039. If you press the gadget `Save' or the corresponding key-shortcut, the
  1040. program will save the current preferences.  The new configuration
  1041. becomes active at once and will be used after a reboot (The preferences
  1042. will be saved in the directory `ENVARC:' and `ENV:' with the name
  1043. `TimeGuardian.config').  Contrary to the standard preferences
  1044. programs `TimeGuardian' won't quit by pressing on the `Save'
  1045. gadget.
  1046.  
  1047. The Gadget `Use'
  1048. ................
  1049.  
  1050. If you press the gadget `Use' or its corresponding key- shortcut, the
  1051. preferences will be saved in the drawer `ENV:' with the same name as
  1052. above.  The configuration will be used immediately, but will stay active
  1053. only as long as the computer won't be rebooted.  If the computer boots,
  1054. the configuration you saved with the gadget `Save' will be used.
  1055.  
  1056. The Gadget `Quit'
  1057. .................
  1058.  
  1059. You may leave the program by clicking on this gadget.  If the
  1060. preferences where changed but not yet saved, a requester will pop up. 
  1061. If you select `Quit', the program will be left without saving.  If you
  1062. select `Cancel' or press the Return key, you'll get back to the
  1063. program.  You may save the preferences manually and leave the program
  1064. afterwards.  By pressing the `Use' button, the changed configuration
  1065. will be used and the program left.  But the changed configuration will
  1066. be lost after the next reboot.
  1067.  
  1068.  
  1069. The Online Help
  1070. ----------------
  1071.  
  1072. The online help is a feature that'll help you while using the graphical
  1073. user interface.  The `amigaguide.library' has to be installed correctly
  1074. (located in the drawer `Libs:') if you want to use this feature.  See
  1075. Where Can I Obtain `Amiga-Guide'?
  1076.  
  1077. If this library has been installed, you may get help about an element of
  1078. the graphical user interface by moving the mouse pointer over it (do not
  1079. click) and pressing the Help key afterwards.  The corresponding text
  1080. from the file `TimeGuardian.guide' will appear.
  1081.  
  1082.  
  1083. The AREXX-Port
  1084. ---------------
  1085.  
  1086. At the present version the program only supports the standard `MUI'
  1087. commands:
  1088.      QUIT              SHOW              HELP
  1089.      HIDE              INFO
  1090.  
  1091. For more information see `MUI.guide' from the distribution of `MUI'.
  1092.  
  1093.  
  1094. What Do the Error Messages Mean ?
  1095. ----------------------------------
  1096.  
  1097.    * `Failed to create Application!'
  1098.      The program was not able to open its window on the active screen.
  1099.      This may happen if you don't have enough free memory. Close some
  1100.      applications or reboot and try it again.
  1101.  
  1102.    * `Cannot quit now,
  1103.      still some ASL popups open!'
  1104.      This message appears if you want to leave the program but still
  1105.      some file requester are open. Close them and try to quit the
  1106.      program again.
  1107.  
  1108.    * `The configuration has been changed
  1109.      and was not saved!'
  1110.      This message reminds you that you haven't saved the modified
  1111.      preferences. They will be lost if you don't save before leaving.
  1112.  
  1113.    * `TGCron is not running!'
  1114.      The background program `TGCron' is not running yet, therefore
  1115.      the changes of the configuration will have no effect! If you want
  1116.      to use the new configuration, you have to start `TGCron'
  1117.      first.
  1118.  
  1119.    * `The file already exists,
  1120.      I will overwrite it!'
  1121.      A file you want to save was already saved with the same name.  If
  1122.      you select `Ok' the old file will be overwritten.  If you select
  1123.      `Cancel' or press return you may save the file with a different
  1124.      name.
  1125.  
  1126.    * `You have to define a Log File,
  1127.      an empty string is not allowed!'
  1128.      You didn't enter anything in a string gadget.  You have to enter a
  1129.      name for the file.
  1130.  
  1131.    * `Invalid config-file: *'
  1132.      The file * is not a valid config file; please select a different
  1133.      file.
  1134.  
  1135.    * `Could not load config-file: *
  1136.      I will use defaults instead!'
  1137.      The file * could not be opened correctly while starting
  1138.      `TimeGuardian'.  The program will use the default values.  Change
  1139.      the configuration to suit your needs and press `Save' to correct
  1140.      the error.
  1141.  
  1142.    * `Could not open scheduler window!'
  1143.      There was not enough free memory available on your system to open
  1144.      the scheduler window. Free some memory and try again.
  1145.  
  1146.    * `This path does not already exist!
  1147.      I will create it!'
  1148.      You entered a non existing path in the string gadget.  You may
  1149.      create it by pressing `OK'.
  1150.  
  1151.  
  1152. The Program `TGScheduler'
  1153. ==========================
  1154.  
  1155. `TGScheduler' isn't an independent program, it's a part of
  1156. `TimeGuardian'.  The following description does *not* refer to an
  1157. independent program.  The scheduler may be used to create a "CronTable"
  1158. in a very easy way.  You don't need to notice the very cryptic syntax
  1159. of the "CronTable" and you may try out your generated event before you
  1160. store it.
  1161. If you want to invoke the scheduler select on the page `Timer' (see The 
  1162. Page `Timer') press one of the `Edit' buttons.  Use your mouse or the
  1163. equivalent short cut.  If the corresponding string gadget already
  1164. contains a file, it will be loaded into the scheduler, otherwise an
  1165. empty "CronTable" will be created.
  1166. `TGScheduler' consist of several windows.  After startup you will
  1167. be on the main window.
  1168.  
  1169.  
  1170. The "Main" Window
  1171. ------------------
  1172.  
  1173. Whether the string gadget contained a file or not, it was loaded or an
  1174. empty listview will appear.  You may manipulate existing tables here. 
  1175. By clicking on the close-gadget you will exit from the scheduler
  1176. without any security requesters, even if you changed something in the
  1177. active table.
  1178. If you already named the current table (by saving it) or you loaded an
  1179. already existing file, the filename will appear in the titlebar of the
  1180. main window.  The length of the complete path and filename is limited
  1181. to 40 characters, if it will be longer than 40 characters the middle of
  1182. the path will be replaced by `...'
  1183. You will see the following elements on the main page:
  1184.  
  1185.  
  1186. The ListView `EventList'
  1187. .........................
  1188.  
  1189. This listview will show the current table you are working on. The
  1190. buttons right beside the listview will act to the highlighted entry. If
  1191. you want to activate an entry you may click it once with your mouse or
  1192. select it with the cursor keys. After that it will be highlighted. If
  1193. there are no entries in the list you may only select the button `New',
  1194. all other buttons will be ghosted.
  1195.  
  1196.  
  1197. The Gadget `New'
  1198. .................
  1199.  
  1200. By pressing this button you may create a new entry for the list left to
  1201. it. It will be entered on top of an empty list or after the highlighted
  1202. entry. A requester will pop up in which you may select the type of your
  1203. new entry.
  1204. There are currently five different types you may choose from:
  1205.    * `Command': A command will be executed by the cron.
  1206.  
  1207.    * `Comment': Those entries contain no information for the cron, they
  1208.      will help you to enter some notes or separate entries for different
  1209.      project, etc. . As they are not important for the cron, you cannot
  1210.      enter time values here.
  1211.  
  1212.    * `Reminder': The cron will invoke the requester/alarm-module of
  1213.      `TimeGuardian'. A requester will pop up, containing the
  1214.      text you have entered before, to remind you of an important event.
  1215.  
  1216.    * `Reminder & Beep': The cron will invoke the requester/alarm-module
  1217.      of `TimeGuardian'. A requester will pop up, containing
  1218.      the text you have entered before, to remind you of an important
  1219.      event. Furthermore your screen will flash for a short moment.
  1220.  
  1221.    * `Alert': The cron will invoke the requester/alarm-module of
  1222.      `TimeGuardian'. An alert will occur, containing the text
  1223.      you have entered before, to remind you of some important event. But
  1224.      you should be very careful using those alerts, as the whole
  1225.      multitasking system will be halted as long as the alert stays
  1226.      active.
  1227.  
  1228. When you have choosen one of these types, the window `Event Input' will
  1229. pop up next, see also The Window `Event Input'.
  1230.  
  1231.  
  1232. The Gadget `Clone'
  1233. ...................
  1234.  
  1235. This button allows you to duplicate the currently active entry. The
  1236. copy will appear below the active entry.
  1237.  
  1238.  
  1239. The Gadget `Change'
  1240. ....................
  1241.  
  1242. By clicking on the `Change' button, the currently active entry will be
  1243. transfered to the editor. You will get the same result by double
  1244. clicking on an entry in the listview or by pressing the Return key
  1245. while your desired entry is highlighted.
  1246.  
  1247.  
  1248. The Gadget `Up'
  1249. ................
  1250.  
  1251. This button allows you to move the active entry one position up. If it
  1252. is already at the top of the listview, nothing will happen. The position
  1253. of an entry in the "CronTable" has no meaning for the cron. But you may
  1254. sort your events to make it easier to read the "CronTable".
  1255.  
  1256.  
  1257. The Gadget `Down'
  1258. ..................
  1259.  
  1260. This button allows you to move the active entry one position down.
  1261.  
  1262.  
  1263. The Gadget `Remove'
  1264. ....................
  1265.  
  1266. By clicking on this button you may remove the currently active entry
  1267. from the table. There will be no security requester, be careful.
  1268.  
  1269.  
  1270. The Gadget `Open'
  1271. ..................
  1272.  
  1273. This button allows you to load a new table into the scheduler. If the
  1274. old table has been changed and was not saved, a security requester will
  1275. pop up and remind you on this fact.
  1276.  
  1277.  
  1278. The Gadget `Save'
  1279. ..................
  1280.  
  1281. You may use this button to save the currently visible table with the
  1282. name given in the titlebar of its window. There won't be a security
  1283. requester. If there will be no name defined in the titlebar, a requester
  1284. will pop up in which you may enter a path and name.
  1285.  
  1286.  
  1287. The Gadget `Save As...'
  1288. ........................
  1289.  
  1290. By clicking on this button you may save the current table with a new
  1291. name. If the selected file already exists a security requester will pop
  1292. up, asking if you really want to overwite the file.
  1293.  
  1294.  
  1295. The Gadget `Clear'
  1296. ...................
  1297.  
  1298. This button may be used to clear the whole table. If you have changed
  1299. the current table, a security requester will appear. Otherwise it will
  1300. be deleted without any interrogation. The name of the table will be
  1301. kept.
  1302.  
  1303.  
  1304. The Gadget `Exit'
  1305. ..................
  1306.  
  1307. This button brings you back to the program `TimeGuardian'.  If you
  1308. changed something at the current table a security requester will pop up.
  1309. If you `Cancel' the requester, you will get back to the scheduler.  If
  1310. you `Exit' from it, you will be back to `TimeGuardian' without
  1311. saving the table.  The middle button alows you to save your data and
  1312. exit after that to `TimeGuardian'.
  1313.  
  1314.  
  1315. The Window `Event Input'
  1316. -------------------------
  1317.  
  1318. Now you are in the part of the program where you may select when a
  1319. certain event will happen. The upper window will be always the same
  1320. regardless which type of event you are working on. Its main purpose is
  1321. to choose *WHEN* your event will take place. *WHAT* will happen may be
  1322. selected with the button at the left top and the second window. The
  1323. second window will be different for each type of event.
  1324. If you want to create a "CronTable" by hand using a texteditor, refer to
  1325. The "CronTable"-Syntax for a detailed description of its syntax.
  1326.  
  1327.  
  1328. The Gadget `Type'
  1329. ..................
  1330.  
  1331. This button shows you which type of event you are currently working on.
  1332. All types may be converted into a `Comment' and all comments may be
  1333. reconverted into their former type.  Furthermore the three types
  1334. `Reminder', `Reminder & Peep' and `Alert' may be converted into each
  1335. other.  You won't be able to convert a `Reminder' to an `Alert',
  1336. because an `Alert' is limited to 78 characters and 20 rows, the size of
  1337. a `Reminder' depends only from your screen resolution.
  1338.  
  1339.  
  1340. The Gadget `Special'
  1341. .....................
  1342.  
  1343. This button influences the behavior of the event. It defines what will
  1344. happen after a event has become active:
  1345.  
  1346.    * Standard: Nothing special will happen. The event will be executed
  1347.      at the predefined points of time.
  1348.  
  1349.    * Once a day: The event will be executed at the predefined points of
  1350.      time, but only once a day.
  1351.  
  1352.    * Once a week: The event will be executed at the predefined points
  1353.      of time, but only once a week.
  1354.  
  1355.    * Once a month: The event will be executed at the predefined points
  1356.      of time, but only once a month.
  1357.  
  1358.    * Once a year: The event will be executed at the predefined points
  1359.      of time, but only once a year.
  1360.  
  1361.    * Use only once: The event will be executed at the predefined point
  1362.      of time, afterwards it will be removed from the "CronTable".
  1363.  
  1364. For example I am using an entry with `once a week' and `* * *' for the
  1365. time values, all month enabled and Sat and Sun (weekend), which reminds
  1366. me to make a backup.  The reminder will pop up always when I start my
  1367. computer for the first time at the weekend.  A `once a day' reminder
  1368. may be used to remind you for example of someones birthday or that
  1369. her/his birthday will come soon.
  1370.  
  1371.  
  1372. The String Gadget `Minutes'
  1373. ............................
  1374.  
  1375. You may enter in this stringgadget at which minutes the event will
  1376. happen. Enter the string like described at The "CronTable"-Syntax or click on
  1377. the button `Edit 1' right beside the gadget to enter it using the help
  1378. window `Minutes', see The Window `Minutes- Hours- Days'.
  1379.  
  1380.  
  1381. The String Gadget `Hours'
  1382. ..........................
  1383.  
  1384. You may enter in this stringgadget at which hours the event will happen.
  1385. Enter the string like described at The "CronTable"-Syntax or click on the
  1386. button `Edit 2' right beside the gadget to enter it using the help
  1387. window `Hours', see The Window `Minutes- Hours- Days'.
  1388.  
  1389.  
  1390. The String Gadget `Days'
  1391. .........................
  1392.  
  1393. You may enter in this stringgadget at which days the event will happen.
  1394. Enter the string like described at The "CronTable"-Syntax or click on the
  1395. button `Edit 3' right beside the gadget to enter it using the help
  1396. window `Days', see The Window `Minutes- Hours- Days'.
  1397.  
  1398.  
  1399. The Gadgets `Months'
  1400. .....................
  1401.  
  1402. You may use this field of buttons to enter at which months the event
  1403. will happen.  A certain month will be activated by pressing its
  1404. appropriate button (recess it).  The `Toggle 4' button may be used to
  1405. invert all entries, recessed (activated) buttons will become raised
  1406. (inactivated) and vice versa.
  1407.  
  1408.  
  1409. The Gadgets `Day of week'
  1410. ..........................
  1411.  
  1412. You may use this field of buttons to enter at which days of the week
  1413. the event will happen. A certain day will be activated by pressing its
  1414. appropriate button (recess it). The `Toggle 5' button may be used to
  1415. invert all entries, recessed (activated) buttons will become raised
  1416. (inactivated) and vice versa.
  1417.  
  1418.  
  1419. The Gadgets `Edit'
  1420. ...................
  1421.  
  1422. A window will pop up which allows you to enter an appropriate string
  1423. for the string gadget. For a detailed description of the windows
  1424. elements refer to The Window `Minutes- Hours- Days'.
  1425.  
  1426.  
  1427. The Gadgets `Toggle'
  1428. .....................
  1429.  
  1430. You may use these two buttons to simply invert the state of the buttons
  1431. left beside them. All active buttons will become inactive and vice
  1432. versa.
  1433.  
  1434.  
  1435. The Window `Comment'
  1436. ---------------------
  1437.  
  1438. This window will appear if you select the event-type `Comment' from the
  1439. cycle button at the left top of the `Event Input' window. Furthermore
  1440. the window where you may enter the time values for an event will become
  1441. ghosted.
  1442.  
  1443. The String Gadget `Comment'
  1444. ...........................
  1445.  
  1446. You may enter a comment text here which will appear in the "CronTable".
  1447.  
  1448. The Gadget `Use'
  1449. ................
  1450.  
  1451. By clicking on this button the text of the string gadget left beside it
  1452. will be entered into the "CronTable". If you don't want to enter this
  1453. text, click on the `close-gadget' of the `Event Input' window to get
  1454. back to the "main" window without any changees.
  1455.  
  1456.  
  1457. The Window `Command'
  1458. ---------------------
  1459.  
  1460. This window will appear if you select the event-type `Command' from the
  1461. cycle button at the left top of the `Event Input' window. Furthermore
  1462. the window where you may enter the time values for an event will become
  1463. active.
  1464.  
  1465. The String Gadget `Arguments'
  1466. .............................
  1467.  
  1468. Enter the arguments here for the command you entered below.
  1469.  
  1470. The String Gadget `Command'
  1471. ...........................
  1472.  
  1473. You must enter the path and name of the command which should be started
  1474. by the cron utility as a background task. If you do not remember the
  1475. exact path, use the button right beside the stringgadget to pop up a
  1476. file requester.
  1477.  
  1478. The Gadget `Test'
  1479. .................
  1480.  
  1481. This button allows you to test your command or script, exactly the same
  1482. will happen when the cron utility starts it later on.
  1483.  
  1484. The Gadget `Use'
  1485. ................
  1486.  
  1487. By clicking on this button the command left beside it will be entered
  1488. into the "CronTable".  If you don't want to enter this command, click
  1489. on the `close-gadget' of the `Event Input' window to get back to the
  1490. "main" window without any change.
  1491.  
  1492.  
  1493. The Window `Reminder- Reminder & Beep- Alert'
  1494. ----------------------------------------------
  1495.  
  1496. You may enter the text in this window which will occur in your
  1497. Reminder, Reminder & Peep or Alert. All windows for the three event
  1498. types will look like the same and therefore are described here together.
  1499. You will see a listview which shows you the actual text entries, as
  1500. same as on the main window of the scheduler. Below the listview you
  1501. will see a stringgadget which allows you to enter your desired text to
  1502. the listview.
  1503. Together with the buttons right beside the listview you get a small
  1504. text editor to create your events.
  1505.  
  1506. The Gadget `New'
  1507. ................
  1508.  
  1509. Use this button to append a new textline to the listview. The text will
  1510. always be appended after the last entry of the listview, regardless
  1511. which entry has been activated by the listview-cursor. The stringgadget
  1512. will be activated and you may enter the new text line there, after
  1513. pressing the RETURN key, the line will be automatically appended to the
  1514. listview. While the stringgadget is active, you have to press the Amiga
  1515. key in conjunction with the underlined character to select the button.
  1516.  
  1517. The Gadget `Clone'
  1518. ..................
  1519.  
  1520. By clicking on this button the highlighted entry will be copied and
  1521. appended at the end of the list.
  1522.  
  1523. The Gadget `Up'
  1524. ...............
  1525.  
  1526. Use this button to move the highlighted entry one position up.
  1527.  
  1528. The Gadget `Down'
  1529. .................
  1530.  
  1531. Use this button to move the highlighted entry one position down.
  1532.  
  1533. The Gadget `Remove'
  1534. ...................
  1535.  
  1536. Use this button to remove the highlighted entry from the list. There
  1537. will appear no security requester before deleting it.
  1538.  
  1539. The Gadget `Test'
  1540. .................
  1541.  
  1542. This button allows you to test your reminder or alert, exactly the same
  1543. will happen when the cron utility starts it later on.
  1544. If you are using an EGS-screen it may happen that you won't see the
  1545. alert. You won't be able to move your mouse pointer as the alert will
  1546. be displayed on a background screen. The only way to get rid of the
  1547. alert will be clicking  on the right mousebutton. This is a problem of
  1548. the EGS-system and we are not able to influence that. The only solution
  1549. will be to use no alerts if you get problems with EGS.
  1550.  
  1551. The Gadget `Use'
  1552. ................
  1553.  
  1554. By clicking on this button the current event will be entered into the
  1555. "CronTable".  If you don't want to enter this event, click on the
  1556. `close-gadget' of the `Event Input' window to get back to the "main"
  1557. window without  any change.
  1558.  
  1559.  
  1560. The Window `Minutes- Hours- Days'
  1561. ----------------------------------
  1562.  
  1563. All of the three windows will look like the same and therefore are
  1564. described here together. The only difference between them are their
  1565. title bars and the ranges of their sliders.
  1566.  
  1567. The Radiobutton `Type'
  1568. ......................
  1569.  
  1570. Use these radio buttons to select which of the sliders you want to
  1571. become active.
  1572.  
  1573.    * Always: None of the sliders will become active, only the `Replace'
  1574.      button will be activated. `Always' means that the event will be
  1575.      executed every minute (hour or day).
  1576.  
  1577.    * Range: You may use the sliders `Begin' and `End' to define a range
  1578.      of minutes (hours or days) when your event will be executed by the
  1579.      cron utility.
  1580.  
  1581.    * Single: You may select a single minute (hour or day) when your
  1582.      event will be executed by the cron utility.
  1583.  
  1584. The Slider `Minute'/ `Hour'/ `Day'
  1585. ..................................
  1586.  
  1587. This slider allows you to select a single point of time.
  1588.  
  1589. The Slider `Begin'
  1590. ..................
  1591.  
  1592. This slider allows you to set the beginning of a range.
  1593.  
  1594. The Slider `End'
  1595. ................
  1596.  
  1597. This slider allows you to set the end of a range.
  1598.  
  1599. The Gadget `Replace'
  1600. ....................
  1601.  
  1602. The `Actual value' will be replaced by the currently choosen point of
  1603. time or range by clicking on this button.
  1604.  
  1605. The Gadget `Add'
  1606. ................
  1607.  
  1608. The choosen point of time or range will be appended to the currently
  1609. visible value (`Actual value'). Simplifications will be automatically
  1610. performed by the program.
  1611.  
  1612.  
  1613. The "CronTable"-Syntax
  1614. -----------------------
  1615.  
  1616. An example file might look like this:
  1617.      # TimeGuardian CronTable
  1618.      #
  1619.      #55 23 * * * RequestChoice TimerRequest "It is 23:55 now!" "What?!"
  1620.      #
  1621.      59 19 * * 1-5 s:News
  1622.      #
  1623.      0,15,30,45 * * * * "newshell con:82/175/550/90/UpTime from batch:saytime"
  1624.      #
  1625.      R 55 23 * * * "It is 23:55 now !"
  1626.      #
  1627.  
  1628. First of all I want to say that a command line must not contain more
  1629. than 450 characters. This results of some Amiga- and
  1630. `TimeGuardian'- specific restrictions. If you need longer commands you
  1631. should use a small script for that.
  1632.  
  1633. If the 1st character of a line is `#' (or `;'), the line will be
  1634. completely ignored.  You may use this to add comments to the file or to
  1635. disable a commandline temporarely.  This is shown in the third line. 
  1636. The command `RequestChoice' won't be executed.
  1637.  
  1638. In order to execute a file at a certain time, the line in the file must
  1639. look like the following example: `[Type] <Minute> <Hour> <Day> <Month>
  1640. <Day_of_week> [Key] <"Text">|<Path/<Command>>'.
  1641. The decision, whether a command will be executed or not, is made by a
  1642. *AND*- combination of the five time parameters. This means that the
  1643. command will only be executed if all five parameters match.
  1644.  
  1645. A detailed description of the different samples, set in acute
  1646. parenthesis, is following here.  Some characters have a certain meaning:
  1647.    - `<>':
  1648.      The parameter in acute parenthesis has to  be specified.
  1649.  
  1650.    - `|':
  1651.      The vertical bar seperates alternative parameters which may be
  1652.      used or not.
  1653.  
  1654.    - `[]':
  1655.      The parameter in angular parenthesis may be used if you want to.
  1656.  
  1657.    - `...':
  1658.      Three periods indicate that the preceding parameter may be used
  1659.      multiple times.
  1660.    * `[Type]'
  1661.      This is an enhancement of the Un*x syntax which provides you the
  1662.      following possibilities:
  1663.      `[#|;|R|B|A]'
  1664.      If you don't enter one of these parameters the rest of the line
  1665.      will be taken as a command. `#' and `;' indicate a comment line
  1666.      and will be ignored by the cron. The parameters `R', `B' and `A'
  1667.      indicate a so called "reminder" or "alert". The `<"Text">' (see
  1668.      below) will be displayed. These single characters are the
  1669.      abbreviations for:
  1670.      R = reminder
  1671.      B = reminder & beep
  1672.      A = alert
  1673.      A reminder is a system requester, which displays the given text,
  1674.      you may use them to remind you on important events (e.g.
  1675.      birthdays). An alert uses a special system screen.
  1676.  
  1677.    * `<Minute>'
  1678.      The complete syntax looks like this:
  1679.      `<*|Min[[,Min]|[,Min-Min]...]|Min-Min[[,Min]|[,Min-Min]...]>'
  1680.      The value for `Min' has to be chosen from the period of 0 to 59.
  1681.      The following is a description of all possibilities:
  1682.        1. `*':
  1683.           If you use an asterisk for this parameter, th command is
  1684.           executed every minute.
  1685.  
  1686.        2. `Min':
  1687.           You may choose a certain point of time at which the command
  1688.           will be executed.
  1689.  
  1690.        3. `Min-Min':
  1691.           You may specify a period of time, during which the command
  1692.           will be executed. The first value for `Min' has to be smaller
  1693.           than or equal the second value for `Min'.
  1694.  
  1695.        4. `<Min>,<Min-Min>,...,<Min>':
  1696.           You may specify multiple points and periods of time seperated
  1697.           by colons. The command will be executed at every specified
  1698.           moment and the specified periods of time.
  1699.  
  1700.      Example: `0,5,10,15-20,30,45-50 * * * * Command'
  1701.      This would start the command every full hour, every five, ten and
  1702.      30 minutes after the full hour and during the period of 15 to 20
  1703.      and of 45 to 50 minutes every minute after the full hour. The
  1704.      command will be executed every single day.
  1705.  
  1706.    * `<Hour>'
  1707.      The complete syntax looks like this:
  1708.     
  1709.     
  1710.     
  1711.      `<*|Hour[[,Hour]|[,Hour-Hour]...]|Hour-Hour[[,Hour]|[,Hour-Hour]...]>'
  1712.      The value for `Hour' has to be chosen from the period of 0 to 23.
  1713.      For a more precise description of the parameter `Hour', consult
  1714.      the parameter `Minute' above. Both parameters have the same syntax.
  1715.      Example: `* 0,3,6,9,12,15,18,21 * * * Command'
  1716.      This would execute the command every three hours. Since an
  1717.      asterisk is used for the minutes, the command will be executed
  1718.      every minute of these hours.
  1719.  
  1720.    * `<Day>'
  1721.      The complete syntax looks like this:
  1722.      `<*|Day[[,Day]|[,Day-Day]...]|Day-Day[[,Day]|[,Day-Day]...]>'
  1723.      The value for `Day' has to be chosen from the period of 1 to 31.
  1724.      For a more precise description of the parameter `Day', consult the
  1725.      parameter `Minute' above. Both parameters have the same syntax.
  1726.      Example: `* * 5-10,20-25 * * Command'
  1727.      This would start the command from the fifth to 10th of a month and
  1728.      at the 20th to 25th of a month. Since asterisks are used for the
  1729.      other parameters, the command will be executed every single minute
  1730.      at these days!
  1731.  
  1732.    * `<Month>'
  1733.      The complete syntax looks like this:
  1734.      `<*|Mon[[,Mon]|[,Mon-Mon]...]|Mon-Mon[[,Mon]|[,Mon-Mon]...]>'
  1735.      The value for `Mon' has to be chosen from the period of 1 to 12.
  1736.      For a more precise description of the parameter `month', consult
  1737.      the parameter `Minute' above. Both parameters have the same syntax.
  1738.      Example: `* * * 1,5-7 * Command'
  1739.      This would start the command in the months from January to May and
  1740.      in July. It will be executed every single minute in these months!
  1741.  
  1742.    * `<Day_of_week>'
  1743.      The complete syntax looks like this:
  1744.      `<*|DoW[[,DoW]|[,DoW-DoW]...]|DoW-DoW[[,DoW]|[,DoW-DoW]...]>'
  1745.      The value for `DoW' has to be chosen from the period of 1 to 7.  1
  1746.      corresponds to Monday, 7 corresponds to Sunday. For a more precise
  1747.      description of the parameter `Day_of_Week', consult the parameter
  1748.      `Minute' above. Both parameters have the same syntax.
  1749.      Example: `* * * * 1-5 Command'
  1750.      This would start the command from Monday to Friday every minute
  1751.      your computer is running.
  1752.  
  1753.    * `[Key]'
  1754.      The complete syntax of this enhancement looks like this:
  1755.      `[§Da[y]|§We[ek]|§Mo[nth]|§Ye[ar]|§Ki[ll]]'
  1756.      Only the first two characters will be checked (`§YE' is equal to
  1757.      `§year').  This check won't be case sensitive, you even might mix
  1758.      up small and capital letters.
  1759.      A commandline which contains such a `key' will be executed only
  1760.      once in the given range of time.  After its execution the
  1761.      commandline will become commented and becomes reactivated at the
  1762.      beginning of a new time-period.  This means for example that a
  1763.      script will be executed once a week (depending on its time
  1764.      parameters, see above), after that it will become deactivated and
  1765.      at the beginning of a new week reactivated. When the time
  1766.      parameters become valid, it gets executed again.
  1767.      The `§Kill' `Key' indicates a special event, after it has become
  1768.      valid the commandline will be removed from the "CronTable".
  1769.      Here are the meanings of the `Keys':
  1770.      `§Day' : will be executed once a day and reactivated at the
  1771.      beginning of a new day
  1772.      `§Week' : will be executed once a week and reactivated at the
  1773.      beginning of a new week
  1774.      `§Month' : will be executed once a month and reactivated at the
  1775.      beginning of a new month
  1776.      `§Year' : will be executed once a year and reactivated at the
  1777.      beginning of a new year
  1778.      `§Kill' : gets removed after a signle execution
  1779.  
  1780.    * `<<"Text">|<Pfad/<Befehl|Skript>>>'
  1781.      You have to enter the command or script here that is supposed to
  1782.      be executed. You always have to use the complete path. In the
  1783.      above example, in line seven, the command `newshell' would need no
  1784.      path, as it this is an *internal* command which is not loaded from
  1785.      any data media. System commands which are located in the `C:'
  1786.      drawer also won't need a path. All other commands will.
  1787.      If you selected a reminder/alert by using `R', `B' or `a' as first
  1788.      character, you have to enter the text quoted. A new line has to be
  1789.      entered as `*N'.
  1790.  
  1791.    * examples:
  1792.        1. `* * * * * "dir >> t:test sys:tools"'
  1793.           This command would be executed every minute.
  1794.  
  1795.        2. `0,30 8-16 * * 1-5 s:Gong'
  1796.           This script would be executed Mondays to Fridays from eight
  1797.           a.m. to four o'clock p.m. every full hour and every half hour.
  1798.  
  1799.        3. `0 15 24 12 * execute "s:Christmas"'
  1800.           This script would be executed at three o'clock p.m. at the
  1801.           24.th of December.
  1802.  
  1803.        4. `0 20 15,16 4 7 s:Example'
  1804.           This script would be executed at the 15th and 16th of April
  1805.           at eight o'clock p.m. (if this date is a Sunday). Of course,
  1806.           two successive days can't be both Sundays, this example is
  1807.           just used to illustrate the *AND*- combination.
  1808.  
  1809.        5. `R 55 23 * * * "You should better*Ngo to bed now!"'
  1810.           At 23:55 you will be sent to bed by your computer.
  1811.  
  1812.        6. `* 18-22 * * * §Day s:Mailbox'
  1813.           Regardless when you switched your computer on for the first
  1814.           time this day, if it is running during 18-22 o'clock it will
  1815.           start the mailbox script.
  1816.  
  1817. If you want to start scripts, the `S- flag' of the files has to be set
  1818. (to do this with the script `News' which is in the directory `S:', type
  1819. the following in a `CLI': `protect s:News s add'). The second way to
  1820. start a script is to use the command `execute' as shown in the third
  1821. example (you don't have to set the `S- flag' here). You have to start
  1822. commands inside scripts with their full path! You won't need the path,
  1823. if you use internal commands or commands in the `C:'-directory. If you
  1824. have any problems with commands, because they are not working properly,
  1825. check the commands for spaces. Try quoting the part of the command
  1826. including spaces. Test the commands you want to use in a `Shell' before
  1827. you enter them to a script.
  1828.  
  1829.  
  1830. The Program `TGCron'
  1831. =====================
  1832.  
  1833. After setting up your preferences with `TimeGuardian', you should
  1834. start `TGCron'.  The program is a so called `Commodity', please
  1835. refer to your manual for the operating system for further information. 
  1836. According to your setup, the program will execute the appropriate
  1837. programs and scripts and store the runtime information of your
  1838. computer.  Its CPU usage is very low.  While waiting for the next event
  1839. it will use *no* CPU power.  CPU power will only be used during startup
  1840. and when it's looking for an event or writing some information to disk
  1841. and apart from that each minute for a short stretch of time.
  1842.  
  1843.  
  1844. What Does `TGCron' Do?
  1845. -----------------------
  1846.  
  1847. `TGCron' was designed to stay in memory all the time and run as a
  1848. background task.  It will execute user defined events at predefined
  1849. points of time.  This means on the one hand that script files will be
  1850. executed and requester or alerts will be shown to remind you about
  1851. important events, on the other hand it will store information about the
  1852. runtime and the time your system was booted.  The precision for these
  1853. informations may be preset in `TimeGuardian'.  It is very important
  1854. to configure `TGCron' according to your personal environment, so
  1855. that it will be able to handle your events.  How ythis should be done,
  1856. see The Program `TimeGuardian'.  As the program stores (after predefined
  1857. intervals) information to your harddisk, it is important not to do a
  1858. reset at these points of time.  It is possible that you would get a
  1859. corrupted file on your harddisk, but that will be corrected during your
  1860. next startup.  (This happened just once during a period of 8 month on
  1861. my system) To be safe don't do a reset at any full minute (:00) or
  1862. remove `TGCron' before you do a reset.  All in all you don't have
  1863. to worry about that as it is not dangerous!
  1864.  
  1865.  
  1866. How May I Get Information About `TGCron'
  1867. -----------------------------------------
  1868.  
  1869. If you want to get further information about `TGCron', please
  1870. enter the following from the CLI (replace `<path>' by the directory you
  1871. have installed the package to):  `<path>/TGCron'
  1872. There are two different messages possible, depending on whether
  1873. `TGCron' has already been started or not.
  1874.   1. `TGCron' has already been started:
  1875.      `TGCron v1.50 (5.1.1995) by G.Körner/J.Matern
  1876.      use -r option to remove...'
  1877.  
  1878.   2. `TGCron' is not yet running:
  1879.      `TGCron v1.50 (5.1.1995) by G.Körner/J.Matern
  1880.      use -i option to install...'
  1881.  
  1882. You may also get information about the revision and the compilation
  1883. date by using the `version'-command.  Enter the following commandline:
  1884. `version full <path>/TGCron'
  1885. It should read: `TGCron v1.50 (5.1.1995)'.
  1886. If this does not happen, you are definitely reading the wrong
  1887. documentation.  Furthermore you may use the `Commodity Exchange'
  1888. program of you workbench to display information on TGCron.
  1889.  
  1890.  
  1891. How May I Start `TGCron'?
  1892. --------------------------
  1893.  
  1894. If you didn't choose the automatic startup option during installation,
  1895. there are two different ways to start `TGCron' by hand:
  1896.   1. Start from CLI:
  1897.      To start from CLI please enter the following: `<path>/TGCron
  1898.      -i'
  1899.      As `TGCron' does not detach from your CLI, you have to use
  1900.      the `run' command to get your shell back after startup as follows:
  1901.      `run < nil: > nil: <path>/TGCron -i'.
  1902.      Replace <path> by the directory the `TimeGuardian' package
  1903.      was installed to.
  1904.  
  1905.   2. Workbench startup:
  1906.      If you want to start `TGCron' from your Workbench, just
  1907.      doubleclick its icon.
  1908.  
  1909. If you try to start the program while it is already running, you will
  1910. get the following results:
  1911.    - At the CLI:
  1912.      You will get the message: `TGCron is already running'
  1913.      Indicating that `TGCron' is already running and may not be
  1914.      restarted.
  1915.  
  1916.    - At the workbench:
  1917.      A requester will pop up, asking you: `Do you want to remove
  1918.      TimeGuardianCron?'
  1919.      If you want to remove it, click on `*Yes*' or press Return.
  1920.      Choosing `No' or pressing Escape will not affect `TGCron' and
  1921.      it will keep on running. Regardless of your choice it won't be
  1922.      started again!
  1923.  
  1924.  
  1925. How May I Stop `TGCron'?
  1926. -------------------------
  1927.  
  1928. If `TGCron' is already running, you have three options to remove
  1929. it:
  1930.   1. From CLI:
  1931.      Please enter the following command:  `<path>/TGCron -r'
  1932.      Replace <path> by the directory the `TimeGuardian'
  1933.      package was installed to.  After tahat you will get the message: 
  1934.      `TGCron will be removed now!'.  The program will be removed
  1935.      from memory at once.
  1936.  
  1937.   2. At the Workbench:
  1938.      Just doubleclick its icon. A requester will pop up, asking you:
  1939.      `Do you want to remove TimeGuardianCron?'
  1940.      If you want to remove it, click on `*Yes*' or press Return. 
  1941.      Choosing `No' or pressing Escape will not affect `TGCron' and
  1942.      it will keep on running.  You won't get any further messages, but
  1943.      just as removing it from CLI, it will quit at once.
  1944.  
  1945.   3. You may use the `Commodity Exchange' program of your workbench to
  1946.      remove `TGCron' from memory.
  1947.  
  1948.  
  1949. What Do the Error Messages Mean?
  1950. ---------------------------------
  1951.  
  1952. You may get the following error messages from `TGCron':
  1953.    * `Not enough free memory!'
  1954.      You have not enough free memory in your system. `TGCron' had
  1955.      to quit.
  1956.  
  1957.    * `Invalid .config file. Use TimeGuardian to create a new one!'
  1958.      `TGCron' tried to read data from the file
  1959.      `env:TimeGuardian.config', but it was changed or corrupted and is
  1960.      not valid any more. Start `TimeGuardian', enter a new
  1961.      configuration, and store it with the `Save' button.
  1962.  
  1963.    * `Could not open env:TimeGuardian.config!
  1964.      Use TimeGuardian to create it'
  1965.      Start `TimeGuardian', enter your configuration and store it
  1966.      with the `Save' button.
  1967.  
  1968.    * `Could not open locale, please check configuration!
  1969.      Using english instead'
  1970.      You have choosen `localized' in the preferences program but the
  1971.      cron couldn't  find the corresponding catalog.
  1972.  
  1973.    * `Your evaluation time has expired for today,
  1974.      Please consider registering !!'
  1975.      You have reached the end of your evaluation time for `TGCron'
  1976.      as an unregistered user. You won't be able to restart it again on
  1977.      this same day. If you want to use the package for a unlimited
  1978.      amount of time, please become a registered user, refer to How Can 
  1979.      I Register for `TimeGuardian'? for detailed information.
  1980.  
  1981.    * `CronParser ERROR:
  1982.      Wrong number of Arguments in CronTable line:
  1983.      CronTab_line
  1984.      Please correct it!'
  1985.      The displayed `CronTab_line' from one of your choosen "CronTables"
  1986.      contains too much or not enough entries. For detailed information
  1987.      on the "CronTable", refer to The "CronTable"-Syntax.
  1988.  
  1989.    * `CronParser ERROR:
  1990.      Bad entry '*' in CronTable line:
  1991.      CronTab_line
  1992.      Please correct it!'
  1993.      The entry '*' in the `CronTab_line' is not valid.  For detailed
  1994.      information on the "CronTab", refer to The "CronTable"-Syntax.
  1995.  
  1996.    * `CronParser ERROR:
  1997.      Value * out of range (*...*)
  1998.      Please search for commandline and fix it !'
  1999.      The number after `Value' is not in the range displayed in
  2000.      parenthesis. For detailed information on the "CronTab", refer to
  2001.      The "CronTable"-Syntax.
  2002.  
  2003.    * `CronParser ERROR:
  2004.      Range *-* out of range (*...*)
  2005.      Please search for commandline and fix it !'
  2006.      The range `*-*' has to be in the range that is shown in
  2007.      parenthesis.  For detailed information on the "CronTable", refer to
  2008.      The "CronTable"-Syntax.
  2009.  
  2010.  
  2011. Where Do I Get the Support Programs?
  2012. *************************************
  2013.  
  2014.  
  2015. Where May I Obtain `MUI'?
  2016. ==========================
  2017.  
  2018. You may get `MUI' directly from the author, where you get a registered
  2019. version (see Where Can I Register for `MUI'?). This allows you to
  2020. use all features of `MUI' and store its configuration permanently. The
  2021. unregistered version is available on many PD-series an via `Aminet'.
  2022.  
  2023. If you think `MUI' is not worth installing, because of one single
  2024. program, you may be right. But the background program `TGCron'
  2025. won't use `MUI' at all. Only the preferences program will use it for its
  2026. graphical user interface. So `MUI' will not be started everytime, but
  2027. if you want to change the configuration. So you may install this
  2028. package even on computers with memory, as you don't need `MUI' all the
  2029. time.
  2030.  
  2031. If you have `MUI' not installed yet, you absolutely have to do this
  2032. before the installation of `TimeGuardian', as the installation
  2033. will be aborted otherwise. See How Do I Install `TimeGuardian'?, for
  2034. further information.
  2035.  
  2036.  
  2037. Where Can I Obtain `Installer'?
  2038. ================================
  2039.  
  2040. For an easy installation of the program package you need the program
  2041. Installer from C*mm*d*re. If this program is not installed on your
  2042. computer, you may obtain it in several ways:
  2043.  
  2044.    * Workbench 2.0/2.1/3.0 includes it
  2045.  
  2046.    * From `Fish-Disk 870'
  2047.  
  2048.    * Via the distribution of `MUI'.
  2049.  
  2050.    * Many distributions of commercial software contain it
  2051.  
  2052.  
  2053. Where Can I Obtain `Amiga-Guide'?
  2054. ==================================
  2055.  
  2056. If you want to use the "online help" you'll need the
  2057. `amigaguide.library' in your `LIBS:'-drawer (see The Online Help). You
  2058. don't need it to run the package `TimeGuardian', but you won't
  2059. be able to use the online help feature.
  2060.  
  2061. The `amigaguide.library' is on the `Fish-Disk 870' and gets distributed
  2062. with Workbench version 3.0.
  2063.  
  2064.  
  2065. How Do I Install `TimeGuardian'?
  2066. *********************************
  2067.  
  2068. This chapter describes the installation of the package
  2069. `TimeGuardian'. If you want to install other packages not included in
  2070. this distribution (see What Do I Need to Be Able to Use 
  2071. `TimeGuardian'?), look into the respective distributions to install them.
  2072.  
  2073. You have two possibilities to install the package
  2074. `TimeGuardian'. You should use the first one:
  2075.  
  2076.  
  2077. The Installation with `Installer'
  2078. ==================================
  2079.  
  2080. Before you make an *update*, read the file `Update_to_1.2'! There
  2081. you'll find important hints on how to make an update.
  2082.  
  2083. You have two choices to start the installation script:
  2084.   1. Doubleclick on the icon `TG.install.deutsch':
  2085.      The installation will commence. The text will appear in german. If
  2086.      you want to use the German text please read the german
  2087.      documentation.
  2088.  
  2089.   2. Doubleclick on the icon `TG.install.english':
  2090.      The installation will commence. The text will appear in english.
  2091.  
  2092. Next is a step by step description of the installation:
  2093.    * At the beginning you may choose the user level for the
  2094.      installation. If you select `Novice', you won't be able to select
  2095.      anything else but the path, where you want to copy the programs to.
  2096.      All files necessary to work correctly will be copied and the
  2097.      preferences program will be started.  Finally you'll get a summary
  2098.      about what was saved to which location. To quit the installation
  2099.      you have to leave the preferences program.
  2100.  
  2101.      If you want to install the package press `Proceed With Install'.
  2102.      With `Help...' you'll get some information.
  2103.  
  2104.    * If you select the user level `EXPERT' you may choose whether you
  2105.      want to install the package (`Install for Real') or whether you
  2106.      just want to test the installation script (`Pretend to Install').
  2107.  
  2108.      Furthermore you may choose, whether all actions are logged or not.
  2109.      You may write the file
  2110.      `Sys:TGInstall.e.log' to disk (`Log File'), print the results
  2111.      (`Printer') or suppress a log file (`None').
  2112.  
  2113.      The installation is continued with `Proceed'.
  2114.  
  2115.    * The installation will check, whether `MUI' was installed in the
  2116.      correct version. If this was not so, the installation will be
  2117.      aborted.
  2118.  
  2119.    * The installationprogramm checks now, if you have already installed
  2120.      a version of `TimeGuardian'. The installation tries to
  2121.      find the old installationpath. When you haven't changed the old
  2122.      installation procedure this should work correctly. A message with
  2123.      the found path will appear. A running `TGCron' will be
  2124.      stopped. This is necessary to make a proper update.
  2125.  
  2126.    * Now you may choose what you want to install.
  2127.      The first gadget means, that only the necessary programs and
  2128.      config files are copied.
  2129.      The second gadget symbolizes the documentation.
  2130.  
  2131.    * If the first gadget was activated:
  2132.         - You will be asked, if the background program `TGCron'
  2133.           should be started every time the computer is booting.
  2134.  
  2135.         - If  you answered the last question with `Yes', the program
  2136.           will check whether this is possible on your system.
  2137.  
  2138.         - If multiple choices exist for starting the background program,
  2139.           you may select which of them you prefer. If you select `From
  2140.           CLI (user-startup)', the file `S:user-startup' will be
  2141.           changed in an appropriate way. If you select `From WB
  2142.           (WBStartup)', the icon of the progam `TGCron' is copied
  2143.           to the drawer `Sys:WBStartup'. Users who work mainly with the
  2144.           workbench should use the second way.
  2145.  
  2146.           Users making an update have to keep in mind to delete the
  2147.           *old* entry in their `user-startup', when you selected the
  2148.           CLI- start at a former installation.
  2149.  
  2150.         - Now you may choose where the programs shall be copied to. The
  2151.           installation will make a proposal. If you want a new drawer
  2152.           for the package created, select `Make New Drawer...',
  2153.           otherwise choose an existing one.
  2154.  
  2155.         - You may continue with the button `Proceed'. The first files
  2156.           will be extracted from the archive.
  2157.  
  2158.         - When you have registered this version of the package your
  2159.           keyfile will be copied now. When you have an variable called
  2160.           `ENV:KEYPATH' on your system, this will be the destination.
  2161.           Otherwise the key is copied to `S:'.
  2162.  
  2163.         - Even if you did not select the documents to be installed, the
  2164.           file
  2165.           `TimeGuardian.guide' will be copied if the file
  2166.           `Libs:amigaguide.library' is installed. If this was not so, a
  2167.           message will appear that you won't be able to use the online
  2168.           help.
  2169.  
  2170.    * If the second gadget was selected:
  2171.         - You can select which of the four files you want to install:
  2172.             1. The file `TimeGuardian.asc' which you may read
  2173.                with any text viewer or editor or print, if you like to.
  2174.  
  2175.             2. The file `TimeGuardian.guide' that you may read
  2176.                with `AmigaGuide'. This file contains the information
  2177.                for the online help. This file will always be copied,
  2178.                when the file `Libs:amigaguide.library' is installed to
  2179.                your system.
  2180.  
  2181.             3. The file `TimeGuardian.dvi' that you may print
  2182.                or view, if you have installed TeX.
  2183.  
  2184.             4. The file `TimeGuardian.ps' that you may print
  2185.                with a Postscript printer.
  2186.  
  2187.         - For the  `.asc' and the `.guide' file you  can select a
  2188.           drawer.
  2189.  
  2190.         - The file `TimeGuardian.guide' will only be installed
  2191.           when in the drawer  `Libs:' the file `amigaguide.library' is
  2192.           found. Otherwise you're informed, that you will not be able
  2193.           to use the online help.
  2194.  
  2195.         - Now you can select a path for the `.tex' file.
  2196.  
  2197.         - Now you can select a path for the `.ps' file.
  2198.  
  2199.    * If you have installed the programs, you may decide now whether you
  2200.      wish to start the preferences program `TimeGuardian'. Start
  2201.      the program by selecting `Yes'. Change the configuration to suit
  2202.      your needs and press the gadget `Save' before you leave the
  2203.      program with the `Quit' gadget. If you haven't started the program
  2204.      yet, you'll have to answer a message that you will have to start
  2205.      the preferences program later on. Select `Proceed' then to leave
  2206.      the installation correctly.
  2207.  
  2208.    * If you have left the preferences program or answered the message,
  2209.      the installation will be complete. Then the final message will
  2210.      appear.
  2211.  
  2212.    * When you selected the option to start the "Cron" program every
  2213.      time your computer is booting, and you have left the preferences
  2214.      program with `Save' `TGCron' is started.
  2215.  
  2216.  
  2217. The Installation without `Installer'
  2218. =====================================
  2219.  
  2220. You should use this step by step installation only as an *expedient*
  2221. when you can't get the `Installer' program.
  2222.  
  2223. Before you make an *update*, read the file `Update_to_1.2'! There
  2224. you'll find important hints on how to make an update.
  2225.  
  2226. To install the package without `Installer' please follow these steps:
  2227.   1. Open a `Shell' window (doubleclick the icon `Shell' in the drawer
  2228.      `System' of your boot partition).
  2229.  
  2230.   2. Please enter `version libs:muimaster.library'. You should get this
  2231.      result:
  2232.      `libs:muimaster.library 7.973'. If you get a smaller number or
  2233.      `object not found' you have to install `MUI' version 2.0 or
  2234.      greater before you can continue.
  2235.  
  2236.   3. If you want to install the package in a drawer that already
  2237.      exists, please enter `cd drawer' (instead of drawer please use the
  2238.      name of the directory). If you want to copy the files to a new
  2239.      drawer you have to create it with the command `makedir drawer',
  2240.      after that change to this drawer with `cd drawer' (please use the
  2241.      name of the new directory instead of `drawer' in the two command
  2242.      lines, e.g. TimeGuardian).
  2243.  
  2244.   4. Please enter `echo > env:TimeGuardian.path drawer' and
  2245.      `echo > envarc:TimeGuardian.path drawer'. Substitute
  2246.      drawer with the path you used above. You have to type the trailing
  2247.      `/' or `:'!
  2248.  
  2249.   5. Now put the disk with the package into any drive (if you have
  2250.      already copied the files to your hard disk just enter: `assign
  2251. {No Value For "     DISKNAME"}: sourcedrawer', in which
  2252.      `sourcedrawer' is the drawer, in which the files on your hard disk
  2253.      are stored).
  2254.  
  2255.   6. To copy the programs enter:`TimeGuardian:Lhx/Lhx e
  2256.      TimeGuardian:bin/TGBins.lha #?'. Some messages will appear, as to
  2257.      which files have already been decrunched.
  2258.  
  2259.   7. If you want to copy the locale files (only German available at the
  2260.      moment) please enter:  `copy
  2261.      TimeGuardian:Catalogs/deutsch/#? Locale:Catalogs/deutsch'. You
  2262.      should get a message about a copied file.
  2263.  
  2264.   8. If you want to copy the english documentation files please enter
  2265.      `TimeGuardian:Lhx/Lhx e
  2266.      TimeGuardian:doc/english/TGDoc.lha #? Help:english/'.
  2267.  
  2268.   9. Please enter `copy TimeGuardian:env/#?  envarc:' and `copy
  2269. {No Value For "     DISKNAME"}:env/#?  env:' now.
  2270.  
  2271.  10. Please enter `copy TimeGuardian:s/#? s:'.
  2272.  
  2273.  11. If the background program shall be started while booting, please
  2274.      enter:
  2275.         - start from Workbench:
  2276.           `copy TGCron.info Sys:WBStartup'
  2277.           Open the drawer `WBStartup' on the Workbench and click at the
  2278.           icon `TGCron'. Activate the menu `Icons=>Information...'
  2279.           or press the keys Amiga i. A window should pop up. Now enter
  2280.           in the string gadget `Default Tool:': `path/TGCron' (you
  2281.           have to replace path with the full path you copied the
  2282.           programs to). Leave the window by clicking on the gadget
  2283.           `Save'.
  2284.           or:
  2285.  
  2286.         - start from user-startup:
  2287.           Add the following lines to the file `s:startup-sequence' or
  2288.           `s:user-startup': `run < nil: >nil: path/TGCron' (you
  2289.           have to replace path with the full path you copied the
  2290.           programs to). You may do this with the help of an  editor.
  2291.  
  2292.  12. If you want to start the preferences program from the same drawer
  2293.      as the standard preferences programs simply enter:  `copy
  2294.      TimeGuardian.info Sys:Prefs'. You have to change the `Default
  2295.      Tool:' as described above at step 10 (from Workbench). Enter the
  2296.      name `path/TimeGuardian' instead of `path/TGCron'!
  2297.  
  2298.  13. To use your personal configuration, start the program
  2299.      `TimeGuardian' and leave it by clicking on the gadget `Save'.
  2300.  
  2301.    It may happen that you run into problems trying to install the
  2302. program as described above. This could happen, if the assign `Help' and
  2303. the drawer `Help:english' don't exist. You may copy the documentation
  2304. files to any other drawer you want. You have to change the file
  2305. `Envarc:AmigaGuide/path' and `Env:AmigaGuide/path' in a way that the
  2306. drawer in which you copied the file `TimeGuardian.guide' will
  2307. be searched. E.g. add the line `dh0:docs' if you copied the above file
  2308. to the drawer `dh0:docs'.
  2309.  
  2310.  
  2311. What is `MUI'?
  2312. ***************
  2313.  
  2314. `MUI' is a program package for users and developers, that provides a
  2315. graphical user interface with many features for the programmer and user.
  2316. `TimeGuardian' is not able to run without `MUI', to be more
  2317. precise, the preferences program `TimeGuardian'!  Therefore `MUI'
  2318. has to be already installed or you have to do it before the
  2319. installation of `TimeGuardian'.  Where to obtain `MUI', see Where
  2320. May I Obtain `MUI'?
  2321.  
  2322.  
  2323. Where Can I Register for `MUI'?
  2324. ================================
  2325.  
  2326.                          This application uses
  2327.                        MUI - MagicUserInterface
  2328.                 (C) Copyright 1993/94 by Stefan Stuntz
  2329.  
  2330.      `MUI' is a system to generate and maintain graphical user
  2331.      interfaces. With the  aid  of  a  preferences program, the user of
  2332.      an application has the ability to customize the outfit according
  2333.      to his personal taste.
  2334.  
  2335.      `MUI' is distributed as shareware. To obtain a complete package
  2336.      containing lots of examples and more information about
  2337.      registration please look for a  file  called  `muiXXusr.lha'  (XX
  2338.      means the latest version number) on your local bulletin boards or
  2339.      on public domain disks.
  2340.  
  2341.           If you want to register directly, feel free to send
  2342.  
  2343.                         DM 30.-  or  US-$ 20.-
  2344.  
  2345.                                   to
  2346.  
  2347.                              Stefan Stuntz
  2348.                        Eduard-Spranger-Straße 7
  2349.                              80935 München
  2350.                                 GERMANY
  2351.  
  2352.  
  2353.  
  2354. Registration Form
  2355. ******************
  2356.  
  2357.      --------8<-------------------------------------8<-----------------
  2358.      REGISTRATION FORM
  2359.      
  2360.          Firm:              ___________________________________________
  2361.      
  2362.          First name, Name:  ___________________________________________
  2363.      
  2364.          Street:            ___________________________________________
  2365.      
  2366.          Location:          ___________________________________________
  2367.      
  2368.          Post code:         ___________
  2369.      
  2370.          Country:           ___________________________________________
  2371.      
  2372.          Telephone:         _____________
  2373.      
  2374.          e-mail:            ___________________________________________
  2375.      
  2376.      I want to become a registered user of the program package TimeGuardian
  2377.      and therefore paid:
  2378.      
  2379.                           Germany       Europe      Rest of the
  2380.                                                       World
  2381.        ----------------------------------------------------------
  2382.        o Cash             o 20DM        o 20DM         o 15US$
  2383.                                         o 15US$
  2384.        ----------------------------------------------------------
  2385.        o Bank Draft       o 20DM
  2386.        ----------------------------------------------------------
  2387.        o Eurocheque       o 20DM        o 20DM
  2388.                                         o 15US$
  2389.        ----------------------------------------------------------
  2390.        o Cheque           o 20DM        o 40DM         o 27US$
  2391.                                         o 27US$
  2392.      
  2393.      Please send the newest version of the above mentioned program package
  2394.      and my personal key file to the address above.
  2395.      
  2396.      
  2397.      
  2398.          ____________________              ___________________________
  2399.             Location, Date                         Signature
  2400.      --------8<-------------------------------------8<-----------------
  2401.  
  2402.